[AAASM-2936] 📝 (docs): Build full multi-page Examples section#118
Conversation
Claude Code review — AAASM-2936 (python-sdk framework-examples refresh)CI stateAll required checks green: Scope vs. acceptance criteria
Good catch by the implementer: on canonical VerdictReady for approval and merge. No CI to fix; scope complete and accurate. — Claude Code |
Claude Code review — AAASM-2936 (python-sdk Examples section, expanded)CI stateGreen: Scope vs. refined acceptance criteria
Accuracy note for the record: the examples read VerdictReady for approval and merge. CI green; refined scope fully covered; content source-accurate. — Claude Code |
Description
Builds a complete, multi-page Examples section into the python-sdk mkdocs docs, grounded entirely in the real
agent-assembly-examplessources (README +src/). This expands the original single-page refresh offramework-examples.mdinto a full section so each framework gets a detailed, source-accurate walkthrough.New
docs/examples/sectionexamples/index.md) — entry point, the offline-by-default note, a "start here" path, and a table mapping each example to the governance control it demonstrates.examples/preparing-the-runtime-environment.md) — shared prerequisites to run any Python example: install (pip install agent-assembly/uv sync --extra dev), cloningagent-assembly-examples, the realuv run python src/main.py(+--mock) commands, mock vs. real-provider mode, and the example env vars (AGENT_ASSEMBLY_GATEWAY_URLdefaulthttp://localhost:8080,AGENT_ASSEMBLY_API_KEY). Includes a note reconciling these example-specific vars with the SDK's ownAASM_*/:7391resolver chain.examples/framework-support.md) — the refreshed adapter <-> example status table and the universalinit_assembly()pattern, relocated here fromdocs/guides/framework-examples.md(viagit mv, history preserved) and re-linked to the per-framework pages. Adds a LlamaIndex row.init_assembly()adapter flow works, prerequisites & real run commands, an annotated code walkthrough frompolicy.py/tools.py/main.py, mkdocs admonitions for offline/mock caveats, the verbatim expected output, and links:langchain-basic-agent,langchain-research-agent,langgraph,crewai-research-crew,openai-agents-sdk,pydantic-ai,google-adk,llamaindex-tool-policy,custom-tool-policy.Nav + link wiring
mkdocs.yml.guides/framework-examples.mdnav entry and repoints all inbound references (index.md,quick-start.md,configuration.md,guides/index.md) to the new Examples section. The internal#langchain-quick-startanchor is preserved.Docs-only change. Accuracy was the priority: every command, env var, flag, code excerpt, and expected-output block is taken from the real example README/
src— nothing invented.Type of Change
Breaking Changes
Related Issues
Closes AAASM-2936
Testing
Describe the testing performed for this PR:
Docs-only Markdown change — no code paths touched. Ran
mkdocs build --strictlocally (with the project'sdocsdependency group): the build passes with no broken nav entries and no broken internal links across the new section. Each per-example page was drafted directly from the upstreamREADME.md+src/*.pyso commands, env vars, code excerpts, and expected output match the real examples.Checklist
mkdocs build --strictclean)